<!DOCTYPE HTML><html>
<head>
    <title>Cello API documentation</title>
    <link rel="shortcut icon" href="images/cello_small.png">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="generator" content="https://github.com/kevinrenskers/raml2html 2.1.2">
    <link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css">
    <script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script>
    <script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script>
    <script type="text/javascript">
      $(document).ready(function() {
        $('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
          hljs.highlightBlock(block);
        });

        $('[data-toggle]').click(function() {
          var selector = $(this).data('target') + ' pre code';
          $(selector).each(function(i, block) {
            hljs.highlightBlock(block);
          });
        });

        // open modal on hashes like #_action_get
        $(window).bind('hashchange', function(e) {
          var anchor_id = document.location.hash.substr(1); //strip #
          var element = $('#' + anchor_id);

          // do we have such element + is it a modal?  --> show it
          if (element.length && element.hasClass('modal')) {
            element.modal('show');
          }
        });

        // execute hashchange on first page load
        $(window).trigger('hashchange');

        // remove url fragment on modal hide
        $('.modal').on('hidden.bs.modal', function() {
          try {
            if (history && history.replaceState) {
                history.replaceState({}, '', '#');
            }
          } catch(e) {}
        });
      });
    </script><style>
      .hljs {
        background: transparent;
      }
      .parent {
        color: #999;
      }
      .list-group-item > .badge {
        float: none;
        margin-right: 6px;
      }
      .panel-title > .methods {
        float: right;
      }
      .badge {
        border-radius: 0;
        text-transform: uppercase;
        width: 70px;
        font-weight: normal;
        color: #f3f3f6;
        line-height: normal;
      }
      .badge_get {
        background-color: #63a8e2;
      }
      .badge_post {
        background-color: #6cbd7d;
      }
      .badge_put {
        background-color: #22bac4;
      }
      .badge_delete {
        background-color: #d26460;
      }
      .badge_patch {
        background-color: #ccc444;
      }
      .list-group, .panel-group {
        margin-bottom: 0;
      }
      .panel-group .panel+.panel-white {
        margin-top: 0;
      }
      .panel-group .panel-white {
        border-bottom: 1px solid #F5F5F5;
        border-radius: 0;
      }
      .panel-white:last-child {
        border-bottom-color: white;
        -webkit-box-shadow: none;
        box-shadow: none;
      }
      .panel-white .panel-heading {
        background: white;
      }
      .tab-pane ul {
        padding-left: 2em;
      }
      .tab-pane h2 {
        font-size: 1.2em;
        padding-bottom: 4px;
        border-bottom: 1px solid #ddd;
      }
      .tab-pane h3 {
        font-size: 1.1em;
      }
      .tab-content {
        border-left: 1px solid #ddd;
        border-right: 1px solid #ddd;
        border-bottom: 1px solid #ddd;
        padding: 10px;
      }
      #sidebar {
        margin-top: 30px;
        padding-right: 5px;
        overflow: auto;
        height: 90%;
      }
      .top-resource-description {
        border-bottom: 1px solid #ddd;
        background: #fcfcfc;
        padding: 15px 15px 0 15px;
        margin: -15px -15px 10px -15px;
      }
      .resource-description {
        border-bottom: 1px solid #fcfcfc;
        background: #fcfcfc;
        padding: 15px 15px 0 15px;
        margin: -15px -15px 10px -15px;
      }
      .resource-description p:last-child {
        margin: 0;
      }
      .list-group .badge {
        float: left;
      }
      .method_description {
        margin-left: 85px;
      }
      .method_description p:last-child {
        margin: 0;
      }
      .list-group-item {
        cursor: pointer;
      }
      .list-group-item:hover {
        background-color: #f5f5f5;
      }
    </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>Cello API documentation</h1><p>www.cellocad.org</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="in_out" class="panel-title">/in_out</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_in_out"><span class="parent"></span>/in_out</a> <span class="methods"><a href="#in_out_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_in_out" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#in_out_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Get a list of input promoter and output gene file names.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="in_out_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/in_out</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a list of input promoter and output gene file names.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li><a href="#in_out_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane" id="in_out_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "files" : [&#39;input_pBAD.txt&#39;,&#39;input_pBM3R1.txt&#39;,&#39;input_pLuxStar.txt&#39;,&#39;input_pTac.txt&#39;,&#39;input_pTet.txt&#39;,&#39;output_BFP.txt&#39;,&#39;output_RFP.txt&#39;,&#39;output_YFP.txt&#39;]
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_in_out__filename_"><span class="parent">/in_out</span>/{filename}</a> <span class="methods"><a href="#in_out__filename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#in_out__filename__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#in_out__filename__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_in_out__filename_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#in_out__filename__get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Get file contents of the specified input promoter file or output gene file.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#in_out__filename__post'" class="list-group-item"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Write a file with the specified text.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#in_out__filename__delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete file.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="in_out__filename__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/in_out</span>/{filename}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get file contents of the specified input promoter file or output gene file.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#in_out__filename__get_request" data-toggle="tab">Request</a></li><li><a href="#in_out__filename__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="in_out__filename__get_request"><h3>URI Parameters</h3><ul><li><strong>filename</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="in_out__filename__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Column-separated text. An input promoter contains a name, low RPU, high RPU, and promoter DNA sequence. An output gene contains a name and DNA sequence, where the DNA sequence will typically contain a ribozyme, RBS, CDS, and terminator concatenated into a single sequence.</p><h3>Body</h3><p><strong>Type: text/plain</strong></p><p><strong>Example</strong>:</p><pre><code>pBAD 0.0082 2.5 ACTTTTCATACTCCCGCCATTCAGAGAAGAAACCAATTGTCCATATTGCATCAGACATTGCCGTCACTGCGTCTTTTACTGGCTCTTCTCGCTAACCAAACCGGTAACCCCGCTTATTAAAAGCATTCTGTAACAAAGCGGGACCAAAGCCATGACAAAAACGCGTAACAAAAGTGTCTATAATCACGGCAGAAAAGTCCACATTGATTATTTGCACGGCGTCACACTTTGCTATGCCATAGCATTTTTATCCATAAGATTAGCGGATCCTACCTGACGCTTTTTATCGCAACTCTCTACTGTTTCTCCATACCCGTTTTTTTGGGCTAGC
</code></pre><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "message": "file input_pBAD.txt does not exist"
} 
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="in_out__filename__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/in_out</span>/{filename}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Write a file with the specified text.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#in_out__filename__post_request" data-toggle="tab">Request</a></li><li><a href="#in_out__filename__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="in_out__filename__post_request"><h3>URI Parameters</h3><ul><li><strong>filename</strong>: <em>required (string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>filetext</strong>: <em>required (string)</em><p>Contents to be written to file.</p></li></ul></div><div class="tab-pane" id="in_out__filename__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "message": "wrote file input_pPhlF.txt"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="in_out__filename__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/in_out</span>/{filename}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete file.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#in_out__filename__delete_request" data-toggle="tab">Request</a></li><li><a href="#in_out__filename__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="in_out__filename__delete_request"><h3>URI Parameters</h3><ul><li><strong>filename</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="in_out__filename__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "message": "deleted file input_pPhlF.txt"
}
</code></pre><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "message": "file input_pPhlF.txt does not exist"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="netsynth" class="panel-title">/netsynth</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_netsynth"><span class="parent"></span>/netsynth</a> <span class="methods"><a href="#netsynth_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_netsynth" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#netsynth_post'" class="list-group-item"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>A Verilog logic specification is convered to wiring diagram (NOR/NOT gates) through logic synthesis. The result is not the final netlist; this endpoint serves to validate the Verilog code.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="netsynth_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/netsynth</h4></div><div class="modal-body"><div class="alert alert-info"><p>A Verilog logic specification is convered to wiring diagram (NOR/NOT gates) through logic synthesis. The result is not the final netlist; this endpoint serves to validate the Verilog code.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#netsynth_post_request" data-toggle="tab">Request</a></li><li><a href="#netsynth_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="netsynth_post_request"><h3>Query Parameters</h3><ul><li><strong>verilog_text</strong>: <em>required (string)</em><p>File contents of a Verilog .v logic specification.</p></li></ul></div><div class="tab-pane" id="netsynth_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: text/plain</strong></p><p><strong>Example</strong>:</p><pre><code>0  OUTPUT      (1)         
1  NOR         (3,2)       
2  NOT         (5)         
3  NOT         (4)         
4  INPUT                   
5  INPUT     
</code></pre><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>If the Verilog is not valid, errors within NetSynth result in a status 500 error.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{"timestamp":1450706258636,"status":500,"error":"Internal Server Error","exception":"java.lang.StringIndexOutOfBoundsException","message":"String index out of range: -1","path":"/netsynth"} 
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="submit" class="panel-title">/submit</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_submit"><span class="parent"></span>/submit</a> <span class="methods"><a href="#submit_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_submit" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#submit_post'" class="list-group-item"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Run Cello!</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="submit_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/submit</h4></div><div class="modal-body"><div class="alert alert-info"><p>Run Cello!</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#submit_post_request" data-toggle="tab">Request</a></li><li><a href="#submit_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="submit_post_request"><h3>Query Parameters</h3><ul><li><strong>jobid</strong>: <em>required (string)</em><p>job name/identifier. A valid name starts with a letter, and only contains letters, numbers, and underscores. The regex for a valid name is [a-zA-Z][0-9a-zA-Z_]+</p></li><li><strong>verilog</strong>: <em>required (string)</em><p>Verilog text (not filepath)</p></li><li><strong>inputs</strong>: <em>required (string)</em><p>Input promoter data. Rows of space-separated name, low, high, dnaseq</p><p><strong>Example</strong>:</p><pre>pTac 0.0034 2.8 AACGATCGTTGGCTGTGTTGACAATTAATCATCGGCTCGTATAATGTGTGGAATTGTGAGCGCTCACAATT
</pre></li><li><strong>outputs</strong>: <em>required (string)</em><p>Output gene data. Rows of space-separated name, dnaseq (each dnaseq should concatenate ribozyme, rbs, cds, terminator)</p><p><strong>Example</strong>:</p><pre>YFP CTGAAGCTGTCACCGGATGTGCTTTCCGGTCTGATGAGTCCGTGAGGACGAAAC</pre></li><li><strong>user_options</strong>: <em>required (string)</em><p>custom flags, not intended for new users. Space + dash separated strings.</p><p><strong>Example</strong>:</p><pre>-figures false -plasmid false -assignment_algorithm hill_climbing
</pre></li></ul></div><div class="tab-pane" id="submit_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "message": "SUCCESS: Loading results page."
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="results" class="panel-title">/results</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_results"><span class="parent"></span>/results</a> <span class="methods"><a href="#results_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_results" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#results_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>List of previous job names</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="results_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/results</h4></div><div class="modal-body"><div class="alert alert-info"><p>List of previous job names</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li><a href="#results_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane" id="results_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "folders": ["job1", "majority_v2"]
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_results__jobid_"><span class="parent">/results</span>/{jobid}</a> <span class="methods"><a href="#results__jobid__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#results__jobid__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_results__jobid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#results__jobid__get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>List of files in job result folder</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#results__jobid__delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete previous job result</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="results__jobid__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/results</span>/{jobid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>List of files in job result folder</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#results__jobid__get_request" data-toggle="tab">Request</a></li><li><a href="#results__jobid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="results__jobid__get_request"><h3>URI Parameters</h3><ul><li><strong>jobid</strong>: <em>required (string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>keyword</strong>: <em>(string)</em><p>Filter by substring within the file name</p><p><strong>Example</strong>:</p><pre>logic_circuit</pre></li><li><strong>extension</strong>: <em>(string)</em><p>Filter by file extension</p><p><strong>Example</strong>:</p><pre>.txt</pre></li></ul></div><div class="tab-pane" id="results__jobid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Array of strings</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="results__jobid__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/results</span>/{jobid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete previous job result</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#results__jobid__delete_request" data-toggle="tab">Request</a></li><li><a href="#results__jobid__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="results__jobid__delete_request"><h3>URI Parameters</h3><ul><li><strong>jobid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="results__jobid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: text/plain</strong></p><p><strong>Example</strong>:</p><pre><code>deleted majority_v2</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_results__jobid___filename_"><span class="parent">/results/{jobid}</span>/{filename}</a> <span class="methods"><a href="#results__jobid___filename__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_results__jobid___filename_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#results__jobid___filename__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get file contents (text or png-bytes).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="results__jobid___filename__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/results/{jobid}</span>/{filename}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get file contents (text or png-bytes).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#results__jobid___filename__get_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="results__jobid___filename__get_request"><h3>URI Parameters</h3><ul><li><strong>jobid</strong>: <em>required (string)</em></li><li><strong>filename</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="ucf" class="panel-title">/ucf</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_ucf"><span class="parent"></span>/ucf</a> <span class="methods"><a href="#ucf_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_ucf" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#ucf_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Get a list of UCF&#39;s owned by the authenticated user. UCF file names should end in the .UCF.json extension. This list does not include the default UCF, Eco1C1G1T1.UCF.json.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="ucf_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/ucf</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get a list of UCF&#39;s owned by the authenticated user. UCF file names should end in the .UCF.json extension. This list does not include the default UCF, Eco1C1G1T1.UCF.json.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li><a href="#ucf_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane" id="ucf_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "files" : [&#39;Eco2C2G2T2.UCF.json&#39;]
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_ucf__filename_"><span class="parent">/ucf</span>/{filename}</a> <span class="methods"><a href="#ucf__filename__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#ucf__filename__post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#ucf__filename__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_ucf__filename_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#ucf__filename__get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Get the JSON for the specified UCF. This can be many Mb&#39;s of data.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#ucf__filename__post'" class="list-group-item"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Upload a new UCF. The UCF JSON is in the request body, and the file name that will be created is the endpoint terminal.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#ucf__filename__delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete a UCF from the user&#39;s account.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="ucf__filename__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/ucf</span>/{filename}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the JSON for the specified UCF. This can be many Mb&#39;s of data.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#ucf__filename__get_request" data-toggle="tab">Request</a></li><li><a href="#ucf__filename__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="ucf__filename__get_request"><h3>URI Parameters</h3><ul><li><strong>filename</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="ucf__filename__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="ucf__filename__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/ucf</span>/{filename}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Upload a new UCF. The UCF JSON is in the request body, and the file name that will be created is the endpoint terminal.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#ucf__filename__post_request" data-toggle="tab">Request</a></li><li><a href="#ucf__filename__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="ucf__filename__post_request"><h3>URI Parameters</h3><ul><li><strong>filename</strong>: <em>required (string)</em></li></ul><h3>Query Parameters</h3><ul><li><strong>filetext</strong>: <em>required (string)</em><p>Contents to be written to file.</p></li></ul></div><div class="tab-pane" id="ucf__filename__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "message" : "wrote file Eco2C2G2T2.UCF.json"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="ucf__filename__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/ucf</span>/{filename}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a UCF from the user&#39;s account.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#ucf__filename__delete_request" data-toggle="tab">Request</a></li><li><a href="#ucf__filename__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="ucf__filename__delete_request"><h3>URI Parameters</h3><ul><li><strong>filename</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="ucf__filename__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "message" : "deleted file Eco2C2G2T2.UCF.json"
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_ucf__filename__validate"><span class="parent">/ucf/{filename}</span>/validate</a> <span class="methods"><a href="#ucf__filename__validate_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_ucf__filename__validate" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#ucf__filename__validate_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Determine if an uploaded UCF is valid.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="ucf__filename__validate_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/ucf/{filename}</span>/validate</h4></div><div class="modal-body"><div class="alert alert-info"><p>Determine if an uploaded UCF is valid.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by basic</div><ul class="nav nav-tabs"><li class="active"><a href="#ucf__filename__validate_get_request" data-toggle="tab">Request</a></li><li><a href="#ucf__filename__validate_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="ucf__filename__validate_get_request"><h3>URI Parameters</h3><ul><li><strong>filename</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="ucf__filename__validate_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>status is either "VALID" or "INVALID"</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
  "status":"VALID"
}
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#in_out">/in_out</a></li><li><a href="#netsynth">/netsynth</a></li><li><a href="#submit">/submit</a></li><li><a href="#results">/results</a></li><li><a href="#ucf">/ucf</a></li></ul></div></div></div></div></body></html>